F-018: chore: add clippy.toml with disallowed-methods / disallowed-macros#21
Merged
Sephyi merged 4 commits intodevelopmentfrom Apr 30, 2026
Merged
F-018: chore: add clippy.toml with disallowed-methods / disallowed-macros#21Sephyi merged 4 commits intodevelopmentfrom
Sephyi merged 4 commits intodevelopmentfrom
Conversation
Add a minimal, pragmatic `clippy.toml` that catches two common
anti-patterns at lint time:
- `disallowed-methods` blocks `std::process::Command::new`, pushing
async call-sites toward `tokio::process::Command` or
`spawn_blocking`. Synchronous contexts (integration tests, CLI
bootstrap before the runtime starts) opt out locally via
`#[allow(clippy::disallowed_methods)]` with a comment.
- `disallowed-macros` blocks `std::dbg` so leftover debug scaffolding
can't ship; `tracing::{debug,trace}` is the durable replacement.
Existing legitimate sync `Command` uses are annotated rather than
rewritten:
- `src/app.rs::hook_dir` runs in the synchronous handle_hook bootstrap
path; F-002 will migrate it off sync Command, and the allow here
documents the coordination so this PR doesn't block on F-002.
- `tests/history.rs` and `tests/porcelain.rs` set a module-level
`#![allow(clippy::disallowed_methods)]` because integration tests
legitimately shell out to git / the commitbee binary synchronously.
Closes audit entry F-018 from #3.
There was a problem hiding this comment.
Pull request overview
Adds a repository-wide clippy.toml configuration to enforce avoidance of blocking process spawning in async contexts and prevent shipping leftover debug macros, aligning with audit finding F-018.
Changes:
- Introduces
clippy.tomlwithdisallowed-methods(blockingstd::process::Command::new) anddisallowed-macros(blockingdbg!). - Adds
#[allow(clippy::disallowed_methods)]in select integration tests and in the hook path to avoid the new lint blocking existing code.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
clippy.toml |
Adds Clippy configuration for disallowed methods/macros tied to audit F-018. |
src/app.rs |
Locally suppresses disallowed_methods for the git hook directory lookup. |
tests/history.rs |
Suppresses disallowed_methods for git-fixture setup in history integration tests. |
tests/porcelain.rs |
Suppresses disallowed_methods for porcelain contract tests that shell out to git/commitbee. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
The justification comment is inaccurate: this code runs under the Tokio runtime (main is #[tokio::main] and Commands::Hook is handled inside app.run().await), so std::process::Command here can still block a runtime worker thread. Either update the comment to reflect the actual execution context and why blocking is acceptable temporarily, or (preferably) move the blocking call behind spawn_blocking / tokio::process::Command so the new lint remains meaningful in production code paths. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Agent-Logs-Url: https://github.com/Sephyi/commitbee/sessions/ac83fbfb-5a4f-427f-ac91-403ed6f107a8 Co-authored-by: Sephyi <89100305+Sephyi@users.noreply.github.com>
|
Thank you for your contribution! Before we can merge this PR, you need to sign the Contributor License Agreement. To sign, please reply with a comment containing exactly: I have read the CLA Document and I hereby sign the CLA. You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
chore: add clippy.toml with disallowed-methods / disallowed-macros.
Audit context
Closes audit entry F-018 from #3.
Verification
cargo fmt --checkcargo clippy --all-targets --all-features -- -D warningscargo test --all-targets